package com.example.swagger.controller;

import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * Copyright(C), 2020-2021, AmbroseCdMeng
 * FileName:    HelloWorldController
 * Author:      AmbroseCdMeng
 * Date:        2021/2/310:12
 * Description: 完成之前的配置后，即可生成文档，但这样的文档主要针对请求本身，描述自动根据方法等命名产生，对用户并不友好。所以通常需要自己增加一些说明以丰富文档内容
 *              可以通过以下注解来增加说明
 *              @Api： 描述类/接口的用途
 *              @ApiOperation： 描述方法用途，给 API 增加说明
 *              @ApiImplicitParam： 描述方法的参数，给参数增加说明
 *              @ApiImplicitParams： 描述方法的参数（Multi-Params），给参数增加说明
 *              @ApiIgnore： 忽略某类/方法/参数的文档
 * History:
 * <author>     <time>      <version>       <desc>
 * 作者姓名     修改时间        版本号           描述
 */
@RestController
public class HelloWorldController {
    @ApiOperation(value = "hello", notes = "notes")
    @RequestMapping("/hello")
    public String hello() throws Exception{
        return "Hello World, Spring Boot";
    }
}
